What’s New in the CygNet v9.5 Help

The v9.5 Online Help includes many documentation updates to describe the new features and enhancements contained in the CygNet Software v9.5 release.

Changes to the v9.5 Online Help

The following documentation items have been added, removed, or revised in the CygNet Software v9.5 Online Help. Changes are listed in order of the Online Help document sections in which they appear.

Alarms

• The maximum number of Enhanced Alarm Configuration (EAC) expressions per condition is now 50 (increased from 20)
• The following alarm calculation types are now documented: CREEP_VAL_POS and CREEP_VAL_NEG
• Added Troubleshooting Enhanced Alarm Configuration topic (added July 2, 2021)
• Added a link to a CygNet Blog post about using Enhanced Alarm Configuration (added July 2, 2021)

Auditing

• Added a new topic on Suppressing SetPoint Auditing Based User ID (updated in Patch-2022-05-12-SetpointAuditSuppression, released June 21, 2022) (added November 30, 2022)

Canvas

• See the What's New in the v9.5 Canvas Help section in the Canvas chapter for more information

CygNet Alarm Manager

• The CygNet Alarm Manager, an Applied Engineering application, is now documented in the CygNet Help (added July 2, 2021)

CygNet Bridge

• The Installing CygNet Bridge topic has been updated to include the new option on the Feature selection page to enter an alternative port binding selection

CygNet Bridge API

• New CygNet Bridge API methods have been added for interacting with CygNet facility attribute records. Methods provided with the Base license type now include the ability to create, update, or delete facility attribute records
• New CygNet Bridge API methods have been added for interacting with CygNet point configuration records. Methods provided with the Base license type now include the ability to retrieve, create, update, or delete point configuration records
• New CygNet Bridge API methods have been added to support data interaction with the CygNet Flow Measurement Service (FMS) including numerous facilities and points operations
• Refer to the CygNet Bridge API Help Page for offline user assistance on these methods (updated July 2, 2021 to support new CygNet UPC UA Server 1.0)
• Added a Connectivity Errors note to Troubleshooting (Undefined variable: .SoftwareNameShort) Bridge (added July 2, 2021)

CygNet Depot

• The CygNet Depot, an Applied Engineering application, is now documented in the CygNet Help (added July 2, 2021)

CygNet Designer

• The CygNet Designer, an Applied Engineering application, is now documented in the CygNet Help (added July 2, 2021)

CygNet Dispatch — Refer to CygNet Measurement notes for documentation additions and updates in support of improved CygNet Dispatch functionality, including the following:

• Configuration File Keywords — new optional configuration file keyword to manage data synchronization
• A Node Description field has been added to provide an additional job sorting mechanism at Job creation
• The Job Report template includes a new Cell Name field in the report definition

CygNet Measurement — several new and updated features are documented in CygNet Measurement including the following areas:

• FMS System/Service
  • Configuration File Keywords - added descriptions of new keywords added to configure the amount of data included in each Sync action for CygNet Dispatch
  • FMS Info items — updated documentation to describe additional info items available for ensuring licensing compliance and monitoring device statistics
  • Normalization Views — updated documentation to include a new option to support only complete spans containing no missing data
  • FMS Batch data items — added support for new FMS Batch data items for custom numeric values that can be used in CygNet Measurement to display custom items in the Raw Data control, in Batch reports, and for exporting values via the Export: Flow-Cal Data CFX command
• FMS Commands
  • Export: Normalization View Data CSV - updated the topic to include support for normalized liquid device data
  • Export: Flow-Cal CFX Data - updated the topic to include support for CFX file version 8.5.0
  • Generate Smart Groups - updated the topic to describe the parameter added to provide the ability to include only the specified definition(s) for smart group generation
  • Import: Device Data CSV - updated the topic to include liquid periodic and configuration data
  • Import: History Data CSV - updated the topic to include support for liquid Nodes with periodic history data
• FMS Controls
  • Configuration control - added and updated information to describe the ability to view configuration data for liquid device Nodes in the Configuration control
  • Configuration control - updated information to describe the ability to view complete Gas Analysis records, regardless of status value
  • Configuration control - added information to describe the ability to recalculate gas data based on wet flowing conditions to adjust values for water content
  • History Graph control - added information to include the option for an automatic "daily" record span view for device data requests exceeding 31 days
• FMS Reports
  • Normalization View report - updated the Normalization View report topic to describe the ability to include configuration data for gas device Nodes
  • Gas Analysis report - updated the Gas Analysis report template topic to describe the added ability to optionally filter reported results by gas analysis record status values
  • Missing Data report - updated the topic to describe the added ability to include estimated and unavailable data in published results

• CygNet Measurement documentation has been amended since the initial CygNet v9.5 Help, and now reflects FMS control functionality provided in patches subsequent to the CygNet Software v9.5 release. CygNet Measurement Help topics assume installation of all "Required" FMS patches, and the new features have been incorporated into applicable Help topic descriptions, in particular those describing behaviors available in the History Grid and Balance controls.

  Additional features now incorporated into v9.5 Help topics include (added November 30, 2022:

  • Balance control - updated the topic (and associated ActiveX control, property, and scripting topics) to describe the new option to show only monthly or daily records in the control (to boost performance) while retaining the option to display hourly records upon request
  • History Grid control - updated the topic (and associated ActiveX control, property, and scripting topics) to describe the new options to highlight cells that contain data causing exceptions, and to multi-select data records generating exceptions and ignore the associated exceptions in a single action
  • The FMS Configuration File Keywords and Configuring Email Options and associated topics have been updated to describe added support for the OAuth 2.0 authentication protocol as an option when emailing FMS reports out of CygNet Measurement.
  • The new functionality is provided by "Required" FMS patches contained in the 95_Patch_Composite.zip available to authorized users from the CygNet Software Download Website via the Weatherford software support portal (login required). See CygNet Software Downloads for additional patch access information.

CygNet OPC Server

• Added a new topic to describe Using External ID-based Tags in the OPC Item for the CygNet OPC Server (added August 27, 2021)
• Other miscellaneous cleanup in the CygNet OPC Server section (added August 27, 2021)

CygNet OPC HDA Server

• Added a new topic to describe Using External ID-based Tags in the OPC Item for the CygNet OPC HDA Server (added August 27, 2021)
• Other miscellaneous cleanup in the CygNet OPC HDA Server section (added August 27, 2021)

CygNet OPC UA Server

• The CygNet OPC UA Server 1.0 is now documented (added July 2, 2021, revised August 27, 2021)

CygNet Report Module

• The CygNet Report Module, an Applied Engineering application, is now documented in the CygNet Help (added July 2, 2021)

CygNet Studio

• Updated the user value options when filtering on the active status of a point
• Updated the Group Navigation Bar control topic to describe the new "Display text" selector available when configuring drop-down levels
• CAS View Control — added details on how to hide default context menu items from display (updated in Patch-2022-04-08-CxHmiCas, released April 21, 2022) (added November 30, 2022)
• Configuring Context Menus and Custom Context Menu topics — updated images and related text (updated in Patch-2022-04-08-CxHmiCas, released April 21, 2022) (added November 30, 2022)

Devices — Communication Devices

• Updated the OPC Comm EIE topic to reflect the addition of an optional "connection compatibility mode" (Advanced options on the device editor) to verify OPC connectivity

Devices — Import/Export Devices

• Made several enhancements to the Text Import EIE section, supplemented the Filtering Data topic with better examples (added July 2, 2021)

Devices — Remote Devices

• Allen Bradley CIP EIE has been updated to reflect support for sending string values
• Amocam 700 EIE documentation now includes two additional topics: Generic Template-Driven Data Groups on implementing generic messages and Opcode and Data Group Mapping on mapping data groups to their corresponding opcode numbers and message class
• DNP3 Emerson EIE device template files have been revised to define a configurable data group (CfgDg) for the DNP3Emerson_FM2x.dtf and DNP3Emerson_FB3000.dtf templates
• eProd EIE now allows decreasing the packet size when polling Dynagraph Card data, using an optional UIS command parameter MaxPoints
• Lufkin MPC/RPC EIE uses retrieved time as the card timestamp for dynacard transactions

• OPC EIE — the following updates have been made to this EIE:

  • the OPC EIE now includes a Quality field added to return OPC data quality status in the data-group transaction
  • the OPC EIE now supports an accessPathSeparator attribute to optionally customize an OPC tag separating character
  • added a new topic Using Sentinel Values to Indicate Unreliable Data about configuring point processing to handle unreliable values returned from an OPC server (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022) (added November 30, 2022)
  • updated OPC EIE Editor - Device Page and OPC EIE - Data Groups with Sentinel Value options (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022) (added November 30, 2022)

• OPC Lufkin EIE — the following updates have been made to this EIE:

  • the OPC Lufkin EIE now includes a Quality field added to return OPC data quality status in the data-group transaction
  • the OPC Lufkin EIE now supports an accessPathSeparator attribute to optionally customize an OPC tag separating character
  • the OPC Lufkin EIE has the ability to retrieve data (including Dynagraph Cards) when utilizing the Matrikon SCADA Modbus OPC server, and new sample templates are now listed
  • updated OPC Lufkin EIE Editor - Device Page and OPC Lufkin EIE - Data Groups with Sentinel Value options (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022) (added November 30, 2022)

• OPC Weatherford EIE — the following updates have been made to this EIE:

  • the OPC Weatherford EIE now includes a Quality field added to return OPC data quality status in the data-group transaction
  • the OPC Weatherford EIE now supports an accessPathSeparator attribute to optionally customize an OPC tag separating character
  • the OPC Weatherford EIE has the ability to retrieve data (including Dynagraph Cards) when utilizing the Matrikon SCADA Modbus OPC server, and new sample templates are now listed
  • updated OPC Weatherford EIE Editor - Device Page and OPC Weatherford EIE - Data Groups with Sentinel Value options (updated in Patch-2022-03-11-OPCEIEs, released March 16, 2022) (added November 30, 2022)
  • indicated support for OPC Baker 8300/8500 protocol devices on the Matrikon ScadaCAC OPC server and OPCWFord_8500.dtf to support Matrikon OPC card retrieval from Baker 8300/8500 protocol devices (added November 30, 2022)

• Totalflow EIE — added K Factor Mass to FMS Configuration Data Group Mapping topic (updated in Patch-2022-05-03-TotalFlow, released May 24, 2022) (added November 30, 2022)

Facilities

• Updated multiple topics to support 41 additional facility attributes, including 30 new 10-character table attributes, 10 new 80-character text attributes, and one large 300-character text attribute for use as a facility comment. All CygNet applications, clients, user interfaces, utilities, APIs, metadata, and schemas have been modified to reflect the new facility attributes.

Gas Measurement Repository (GMR)

• Added the following note "Effective with the CygNet v9.5 release, the GMR service will no longer start." to several topics (added July 2, 2021)

General Notification Service (GNS)

• Updated descriptions for VOICE_SIP_HOST_USER and VOICE_SIP_LINE_COUNT in the following topics:
  • Configuring VoIP Properties
  • GNS Configuration File Keywords

• Added documentation support for the OAuth 2.0 (Graph API) authentication protocol for email processing , including (added November 30, 2022):

  • Added a topic on how to configure Azure Active Directory, Microsoft 365 server, and CygNet’s GnsConfig utility to work together to send and receive email messages using Graph API. See Configuring Microsoft 365 to work with Graph API.

  • Updated documentation support for Email Messsage notification type

  • Updated the Email page of the GNS Configuration Tester utility and the GNS configuration file (Gns.cfg) to reflect support for the OAuth 2.0 authorization mode

  • Updated the documentation for the VoIP page of the GNS Configuration Tester utility to reflect usability changes to the page

  • See added and modified keywords in the GNS configuration file (Gns.cfg) in the Services section below

Glossary

• Added a entry for Timestamp ordinal

Link

• Configuring Link has been updated to document several new features, including:
  • Filtering data with facilityFilter and pointFilter, wildcards
  • supported tag formats
  • environment mode
  • device IDs for Dynacard data
  • historical rollup
  • strict point validation and strict point value validation
  • The Link chapter has been reorganized to aid readability

Points

• Added a long-form topic about how status bits, point status, point states, alarm conditions, alarm priority categories, and the point scheme work together to provide status information about a real-time record (RTR) in a Current Value Service (CVS) (added July 2, 2021)

Scripting

• Revised the CxEventIF object documentation
• Updated SetPointEx2 method documentation (added July 2, 2021)
• Updated description for the GetDataGroupTxDataWithRefs method in CxDds.DdsClient (added July 2, 2021)

• CxDds.DdsClient — documented new methods to support adding, deleting, and modifying a data group transaction through the COMAPI interface. Identified multithreaded calls. Reformatted code examples (updated in limited patch April 22, 2022) (added November 30, 2022):
  • AddDataGroupTransaction
  • AddDataGroupTransactionByFile
  • AddDataGroupTransactionByID
  • DeleteDataGroupTransaction
  • DeleteDataGroupTransactionByDbKey
  • DeleteDataGroupTransactionByFile
  • UpdateDataGroupTransaction
  • UpdateDataGroupTransactionByFile

Security

• Update a note about point-level security application override

Service Monitoring Info Items — The following info items are now documented:

• AGENT_COUNT_OF_TIME_CHANGES
• AGENT_LOAD_AVG_1_MIN
• AGENT_LOAD_AVG_5_MIN
• AGENT_LOAD_AVG_15_MIN
• AGENT_LOCAL_DUMPS
• AGENT_PENDING_WIN_UPDATES
• FMS_ACT_DEVICE_CNT
• FMS_INACT_DEVICE_CNT
• FMS_LIC_METER_CNT
• FMS_LIC_METER_USAGE
• LOGQUEUED_ELS (added July 2, 2021)
• LOGREJECTED_ELS (added July 2, 2021)
• REPL_DBS_RECHECK_KEY
• UIS_DDS_CACHE_ERRS (added July 2, 2021)

Services

• Clarified a split service directory configuration
• Fixed the hyperlinks on the Data Flow diagram (added July 2, 2021)
• Added the ACTIVE_DIRECTORY_TLS_USAGE keyword to ACS Configuration File Keywords (added July 2, 2021)

• Added several new keywords to the FMS Configuration File Keywords topic to support OAUTH 2.0 email authorization mode (added November 30, 2022):  
  • EMAIL_AUTH_MODE
  • EMAIL_OAUTH_TYPE
  • EMAIL_OAUTH_AUTHORITY
  • EMAIL_OAUTH_TENANT
  • EMAIL_OAUTH_CLIENT_ID
  • EMAIL_OAUTH_CLIENT_SECRET
• Added several new keywords to the GNS Configuration File Keywords topic to support OAUTH 2.0 email authorization mode (added November 30, 2022):
  • EMAIL_AUTH_MODE
  • EMAIL_CHECK_CERT_REVOKE_LISTS
  • EMAIL_OAUTH_AUTHORITY
  • EMAIL_OAUTH_CLIENT_ID
  • EMAIL_OAUTH_CLIENT_SECRET
  • EMAIL_OAUTH_TENANT
  • EMAIL_OAUTH_TYPE
  • GRAPH_RESPONSE_TIMEOUT
  • POP3_PASSWORD
  • POP3_USERNAME
  • SMTP_PASSWORD
  • SMTP_USERNAME
• Two existing keywords are now used by both the POP and GRAPH API servers, so they have been renamed and moved to the Shared Mail Settings section of the to the GNS Configuration File Keywords topic (added November 30, 2022):
  • EMAIL_POLLING_RATE (previously POP3_UPDATE_RATE)
  • EMAIL_RETAIN_COUNT (previously POP3_EMAIL_RETAIN_COUNT).

System Administration

• Updated CygNet Message Sniffer Lite utility to documents new delta timing columns, and duplicate message detection

Well Test

• Documented changes to the Exit and Script Action types:
  • Exit — Enhanced to allow the well test to exit the entire action sequence. An Exit command check box has been added to the Exit action configuration (and xml) to allow the well test to exit out of the entire action sequence
  • Script — Enhanced to skip well test result processing. A Process output check box has been added to the Script action configuration (and xml) to allow for the execution of script without processing return data into a well test record. When this option is selected, the Well Test module will attempt to process the output as a well test result
• The Configuring CygNet Well Test section has been updated to show examples and configuration requirements for field configurations with multiple headers
• Added topic Customizing the Well Test Configuration Screen to describe new properties on the Canvas Well Test Control